Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proto: Remove superfluous #[doc(hidden)] fuzzing #2104

Merged
merged 1 commit into from
Dec 21, 2024

Conversation

gretchenfrage
Copy link
Collaborator

The module is already #[cfg(fuzzing)], which should make it not appear in docs.


See #2097

I manually confirmed that the module doesn't appear when running cargo doc locally. However, I'm aware that docs.rs does some stuff about annotating which conditions different items are feature-gated behind, platform-gated behind, etc, which running cargo doc doesn't. I don't know how that works, whether it's a feature of cargo doc or something docs.rs has hacked on top, or how to recreate it locally. I'm hoping that it being #[cfg(fuzzing)]--notably, not a feature--will make it just not appear. But if we notice that it's popped up on the next release then we might have to revert.

The module is already `#[cfg(fuzzing)]`, which should make it not appear
in docs.
Copy link
Collaborator

@Ralith Ralith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think docs.rs is capable of setting random cfg flags.

@djc djc added this pull request to the merge queue Dec 20, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Dec 20, 2024
@djc djc added this pull request to the merge queue Dec 20, 2024
@djc djc removed this pull request from the merge queue due to a manual request Dec 20, 2024
@djc djc added this pull request to the merge queue Dec 21, 2024
Merged via the queue into quinn-rs:main with commit 16f83d1 Dec 21, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants